From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 9 Nov 2024 09:55:49 +0000 (+0200)
Subject: Document issues with 'use-package's ':custom' and byte compilation
X-Git-Tag: archive/raspbian/1%30.1+1-3+rpi1^2~2^2~20^2~287
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=b1be0f2ba6b05b7644080638ae26e619cbeac75c;p=emacs.git

Document issues with 'use-package's ':custom' and byte compilation

* doc/misc/use-package.texi (User options): Warn against
byte-compiling init files that use ':custom'.  (Bug#73609)
---

diff --git a/doc/misc/use-package.texi b/doc/misc/use-package.texi
index da3deb081d9..0ac0341fdc7 100644
--- a/doc/misc/use-package.texi
+++ b/doc/misc/use-package.texi
@@ -1416,6 +1416,13 @@ for the same variable, as this risks having conflicting values in your
 use-package declaration and your @code{custom-file}, which can lead to
 problems that are both tricky and tedious to debug.
 
+Also note that if you use @code{:custom} in a file that you
+byte-compile, you could have some unexpected results if you later load
+or @code{require} @file{use-package} (e.g., due to lazy loading): the
+value of the corresponding user options could be reset back to their
+initial values.  We therefore recommend against byte-compiling files
+that use @file{use-package} with @code{:custom} settings.
+
 @node Faces
 @section Faces
 @cindex faces, setting